{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Py4Hw User Guide \n",
    "\n",
    "Py4Hw is a Python library that allows to describe, display, simulate, and generate Verilog for digital circuits without the need of any other HDL tool.\n",
    "\n",
    "In this notebook we will learn how to use it. Launch it in Binder by clicking the icon of the README.md for an better user experience.\n",
    "\n",
    "\n",
    "Follow it step by step for an incremental view of the library or browse the following table of contents.\n",
    "\n",
    "\n",
    "## 0. Setting Up (Not necessary if running from Binder)\n",
    "> ### 0.1 [Installing the library](s00/installing.ipynb)\n",
    "> ### 0.2 [Cloning the development repository](s00/cloning.ipynb)\n",
    "\n",
    "## 1. Basics\n",
    "> ### 1.1 [Hardware Design Style](s01/DesignStyle.ipynb)\n",
    "> ### 1.2 [Object Oriented Approach](s01/OO.ipynb)\n",
    "> ### 1.3 [HWSystem](s01/HWSystem.ipynb)\n",
    "> ### 1.4 [Logic](s01/Logic.ipynb)\n",
    "> ### 1.5 [Ports](s01/Ports.ipynb)\n",
    "> ### 1.6 [Wires](s01/wires.ipynb)\n",
    "> ### 1.7 [Interfaces](s01/Interfaces.ipynb)\n",
    "> ### 1.8 [Abstract Logic](s01/abstract.ipynb)\n",
    "\n",
    "## 2. Combinational Primitive Blocs\n",
    "> ### 2.1 [Bitwise Logic Operations](s02/logic.ipynb) \n",
    "> ### 2.2 Logical and Relational Operations\n",
    "> ### 2.3 Bit manipulation\n",
    "\n",
    "## 3. Sequential Primitive Blocks\n",
    "> ### 3.1 Registers\n",
    "> ### 3.2 Memories\n",
    "\n",
    "## 4. Advanced Sequential Blocks\n",
    "> ### 4.1 [FSMs](s04/FSMs.ipynb)\n",
    "> ### 4.2 [Clocked Processes (Algorithmic Design Style)](s04/Process.ipynb)\n",
    "> ### 4.3 [Clock enabling](s04/ClockEnable.ipynb)\n",
    "\n",
    "## 5. Simulation\n",
    "> ### 5.1 [The simulator](s05/Simulation.ipynb)\n",
    "> ### 5.2 [Scopes](s05/Scopes.ipynb)\n",
    "> ### 5.3 [Waveforms](s05/Waveforms.ipynb)\n",
    "\n",
    "## 6. Visualization\n",
    "> ### 6.1 [Schematic Viewer](s06/Visualization.ipynb)\n",
    "> ### 6.2 [Manipulating Schematics](s06/Manipulating.ipynb)\n",
    "> ### 6.3 Interactive workbench\n",
    "\n",
    "## 7. Synthesis\n",
    "> ### 7.1 [RTL generation](s07/RTLGeneration.ipynb)\n",
    "\n",
    "## 8. Advanced Features\n",
    "> ### 8.1 [Dealing with unique instances, unique blocks and parametetric blocks](s08/Structures.ipynb)\n",
    "\n",
    "\n",
    "## 9. IP library\n",
    "> ### 9.1 [Current blocks](s09/Blocks.ipynb)\n",
    "> ### 9.2 Future goals\n",
    "\n",
    "## 10. Internals\n",
    "> ### 10.1 Behavioural Modeling\n",
    "> ### 10.2 Cycle Based Simulation\n",
    "> ### 10.3 Schematic Visualization\n",
    "> ### 10.4 [Comparing with other Python based HDLs](s10/Comparing.ipynb)\n",
    "\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.11.5"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}
